// Copyright 2016 Proyectos y Sistemas de Mantenimiento SL (eProsima).
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// ------------------------------------------------------------------
// Modification history:
// feature: DServer support simple entity
// feature: Unified Transport Abstraction Layer Unified Transport Abstraction Layer
// ------------------------------------------------------------------

#ifndef INCLUDE_VBS_TRANSPORT_RAWTRANSPORTDESCRIPTOR_H_
#define INCLUDE_VBS_TRANSPORT_RAWTRANSPORTDESCRIPTOR_H_

#include <transport/SocketTransportDescriptor.h>

namespace vbs {
namespace transport {

/**
 * RAW Transport configuration
 *
 * - \c m_output_raw_socket: source port to use for outgoing datagrams.
 *
 * - \c non_blocking_send: do not block on send operations. When it is set to true, send operations
 * will return immediately if the buffer is full, but no error will be returned to the upper layer.
 * This means that the application will behave as if the datagram is sent and lost.
 *
 * @ingroup TRANSPORT_MODULE
 */
struct RAWTransportDescriptor : public SocketTransportDescriptor {
    //! Destructor
    virtual ~RAWTransportDescriptor() = default;

    //! Constructor
    RTPS_DllAPI RAWTransportDescriptor();

    TransportInterface* create_transport() const override;

    //! Copy constructor
    RTPS_DllAPI RAWTransportDescriptor(const RAWTransportDescriptor& t) = default;

    //! Copy assignment
    RTPS_DllAPI RAWTransportDescriptor& operator=(const RAWTransportDescriptor& t) = default;

    //! Comparison operator
    RTPS_DllAPI bool operator==(const RAWTransportDescriptor& t) const;

    TransmitorType get_type() const override;
    //! Source port to use for outgoing datagrams
    uint16_t m_output_raw_socket;

    /**
     * Whether to use non-blocking calls to send_to().
     *
     * When set to true, calls to send_to() will return immediately if the buffer is full, but
     * no error will be returned to the upper layer. This means that the application will behave
     * as if the datagram is sent but lost (i.e. throughput may be reduced). This value is
     * specially useful on high-frequency best-effort writers.
     *
     * When set to false, calls to send_to() will block until the network buffer has space for the
     * datagram. This may hinder performance on high-frequency writers.
     */
    bool non_blocking_send = false;
};

}  // namespace transport
}  // namespace vbs

#endif  // INCLUDE_VBS_TRANSPORT_RAWTRANSPORTDESCRIPTOR_H_
